BeginObtainNewCertificate(IEasyUAClientServerApplication,UACertificateRequestParameters,IProgress<String[]>) Method

Begins an asynchronous operation that obtains a new application own certificate from the certificate manager, and stores it for subsequent usage.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<ExtensionAttribute()>
<NotNullAttribute()>
Public Overloads Shared Function BeginObtainNewCertificate( _
   ByVal application As IEasyUAClientServerApplication, _
   ByVal parameters As UACertificateRequestParameters, _
   ByVal progress As IProgress(Of String()) _
) As IAsyncResult

'Usage
 
Dim application As IEasyUAClientServerApplication
Dim parameters As UACertificateRequestParameters
Dim progress As IProgress(Of String())
Dim value As IAsyncResult
 
value = IEasyUAClientServerApplicationExtension.BeginObtainNewCertificate(application, parameters, progress)

[Extension()]
[NotNull()]
public static IAsyncResult BeginObtainNewCertificate( 
   IEasyUAClientServerApplication application,
   UACertificateRequestParameters parameters,
   IProgress<string[]> progress
)

[Extension()]
[NotNull()]
public:
static IAsyncResult^ BeginObtainNewCertificate( 
   IEasyUAClientServerApplication^ application,
   UACertificateRequestParameters^ parameters,
   IProgress<array<String^>>^ progress
)

Parameters

application: The OPC UA client/server application object that will perform the operation.
parameters: The parameters describing how the certificate should be obtained.
progress: A provider for progress updates.

Exceptions

Exception Description

Exception	Description
System.ArgumentNullException	A `null` reference (`Nothing` in Visual Basic) is passed to a method that does not accept it as a valid argument. This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.

System.ArgumentNullException

A null reference (Nothing in Visual Basic) is passed to a method that does not accept it as a valid argument.

This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.

Remarks

The operation is asynchronous, because it involves multiple steps, and waiting for a finalization of the request by the GDS (see the OpcLabs.EasyOpc.UA.Gds.IEasyUACertificateManagement.FinishRequest method). End of the operation is handled by the EndObtainNewCertificate method. The operation can be cancelled using the CancelObtainNewCertificate method.

For a synchronous alternative, see the ObtainNewCertificate(IEasyUAClientServerApplication,UAEndpointDescriptor) extension method and its overloads.

For a task-based asynchronous programming pattern alternative, see the ObtainNewCertificateAsync(IEasyUAClientServerApplication,UAEndpointDescriptor) extension method and its overloads.

Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows

Reference

IEasyUAClientServerApplicationExtension Class
IEasyUAClientServerApplicationExtension Members
Overload List

Send Documentation Feedback. Technical Support